docs: fix broken links #4217
docs: fix broken links #4217
Conversation
k8s-ci-robot
added
release-note-none
k8s-ci-robot
added
the
size/M
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/assign @rikatz |
| [options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig | ||
| [targetRefs]: ../references/spec/#localpolicytargetreferencewithsectionname | ||
| [subjectAltNames]: ../references/spec/#subjectaltname | ||
| [options]: ../references/spec/#gatewaytlsconfig |
There was a problem hiding this comment.
this's a map, let's link to backendtlspolicyspec.
rikatz
left a comment
rikatz
left a comment
There was a problem hiding this comment.
some links are broken, can you please double check?
for instance here is a preview of the changes: https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/
k8s-ci-robot
removed
the
lgtm
updated |
| [targetRefs]: ../references/spec/#gateway.networking.k8s.io/v1alpha2.PolicyTargetReference | ||
| [subjectAltNames]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation | ||
| [options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig | ||
| [targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname |
There was a problem hiding this comment.
This is still not working. On https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/api-types/backendtlspolicy/ if you click on TargetRefs it will give you a 404.
| [targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname | |
| [targetRefs]: ../reference/spec.md#localpolicytargetreferencewithsectionname |
There was a problem hiding this comment.
btw it should be here: https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/reference/spec/#localpolicytargetreferencewithsectionname
I suggest running a make live-docs on your local computer and testing all of the links :)
There was a problem hiding this comment.
Thanks for your patient, I double checked this page, it should be fine now.
we can add linkinator to help this in the future.
There was a problem hiding this comment.
no worries, I appreciate your effort on fixing it!
There is some ongoing effort to do this as a python hook: #3999
It is still probably too soon to try it, but I saw the authors of mkdocs material (which we use) are moving to a new approach as well: https://zensical.org/
Anyway, we can probably use linkinator as a github action (https://github.com/JustinBeckwith/linkinator#github-actions), it would be great if they provided also a docker image so we could add as some part of "make verify" here :) (I am scared of vendoring half of the internet for npx stuff!)
If you want to give it a try, and let us know on some issue later how your experiments with it or even something like https://github.com/lycheeverse/lychee would be great!
There was a problem hiding this comment.
I tried it locally, but it has almost over 1,000+ broken links. I haven't had enough bandwidth to fix it recently
There was a problem hiding this comment.
no worries, we can do it split on multiple efforts/parts! thanks
| [subjectAltNames]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation | ||
| [options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig | ||
| [targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname | ||
| [subjectAltNames]: ../reference/spec/#subjectaltname |
There was a problem hiding this comment.
this has the same problem as above
| [options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig | ||
| [targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname | ||
| [subjectAltNames]: ../reference/spec/#subjectaltname | ||
| [options]: ../reference/spec/#backendtlspolicyspec |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: rikatz, zirain The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
4 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: